Skip to main content

Gửi tin nhắn preview link

HTTP request

POST https://{app_id}.api.piscale.com/chat-bot/v1.0/messages

Request body

Ví dụ
{
"thread_id": "34161994212846",
"ext_user_ids": [],
"user_ids": [],
"body": {
"text": "Mọi người xem docs ở đây nè: https://docs.communi.io/docs/overview",
"metadata": [
{
"sitename": "docs.communi.io",
"description": "Communi Chat SDK cung cấp mọi thứ bạn cần để xây dựng trải nghiệm giao tiếp hấp dẫn trên ứng dụng của bạn, dành cho người dùng của bạn, theo cách mà bạn muốn",
"source_url": "https://docs.communi.io/docs/overview",
"source_thumb_url": "https://preview-image.piscale.com/https://docs.communi.io/img/sdk-social-card.png",
"title": "Welcome to Communi Chat SDK | Communi Chat SDK",
"type": "preview_link"
}
]
}
}
TênKiểu dữ liệuMô tảBắt buộc
thread_idstringMã cuộc hội thoại
ext_user_idsarrayDanh sách ext_user_id
user_idsarrayDanh sách user_id
body.textstringNội dung văn bản
body.metadataarrayDanh sách hình ảnh
note
  • Bắt buộc thread_id hoặc ext_user_ids hoặc user_ids phải có dữ liệu.
  • Đích đến của tin nhắn sẽ được ưu tiên theo thứ tự thread_id, ext_user_ids, user_ids.
  • ext_user_ids tối đa 1000 phần tử.
  • user_ids tối đa 100 phần tử.

Giải thích các thuộc tính của metadata:

TênKiểu dữ liệuMô tảBắt buộc
typestringPhải là "preview_link"
titlestringTiêu đề
sitenamestringTên site
descriptionstringMô tả của site
source_urlstringĐường dẫn liên kết
source_thumb_urlstringĐường dẫn ảnh thumb

Response

Nếu thành công, bạn sẽ nhận được phản hồi.

Ví dụ
{
"message_code": "M200",
"message": "Success"
}
TênKiểu dữ liệuMô tả
message_codestringMã thông điệp. Xem chi tiết
messagestringNội dung mã thông điệp